fix: resolve issue handling protobuf responses in rest streaming #604
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
parthea
force-pushed
the
fix-rest-streaming
branch
from
c9e3277 to
4a92058
Compare
parthea
force-pushed
the
fix-rest-streaming
branch
from
4a92058 to
ad79bf0
Compare
vchudnov-g
approved these changes
Feb 13, 2024
google/api_core/rest_streaming.py
Outdated
| return self._response_message_cls.from_json(self._ready_objs.popleft()) | ||
| if issubclass(self._response_message_cls, proto.Message): | ||
| return self._response_message_cls.from_json(self._ready_objs.popleft()) | ||
| else: |
There was a problem hiding this comment.
nit: for safety and future-proofing, maybe this should be an elif and we check for google.protobuf.Message
(I realize we don't expect to ever have the second check fail if we get here....but "we don't expect" == "famous last words")
(not a blocker)
tests/unit/test_rest_streaming.py
Outdated
| responses = [EchoResponse(content="hello world"), EchoResponse(content="yes")] | ||
| @pytest.mark.parametrize( | ||
| "random_split,resp_message_is_proto_plus,response_type", | ||
| [(False, True, EchoResponse), (False, False, httpbody_pb2.HttpBody)], |
There was a problem hiding this comment.
Given that you're not testing different combinations of resp_message_is_proto_plus and response_type, and that you're already switching on the first to construct the responses (which you have to because they take different parameters): I suggest you don't parametrize on response_type and instead, in the function, do
if resp_message_is_proto_plus:
response_type = EchoResponse
responses = [EchoResponse(content="hello world"), EchoResponse(content="yes")]
else:
response_type = httpbody_pb2.HttpBody
responses = [
httpbody_pb2.HttpBody(content_type="hello world"),
httpbody_pb2.HttpBody(content_type="yes"),
]
tests/unit/test_rest_streaming.py
Outdated
| Song(title="another song", date_added=datetime.datetime(2021, 12, 17)), | ||
| ] | ||
| @pytest.mark.parametrize( | ||
| "random_split,resp_message_is_proto_plus,response_type", |
There was a problem hiding this comment.
Same comment as above: since you have the if below already, don't parametrize on response_type
tests/unit/test_rest_streaming.py
Outdated
| @pytest.mark.parametrize("random_split", [True, False]) | ||
| def test_next_stress(random_split): | ||
| @pytest.mark.parametrize( | ||
| "random_split,resp_message_is_proto_plus,response_type", |
There was a problem hiding this comment.
Ditto on parametrization
| ), | ||
| Song(title='\\{"key": ["value",]}\\', composer=composer_with_relateds), | ||
| ] | ||
| @pytest.mark.parametrize( |
…essage or google.protobuf.message.Message
product-auto-label
bot
added
size: l
This was referenced Feb 13, 2024
|
/cherry-pick v1 |
parthea
added a commit
that referenced
this pull request
Feb 13, 2024
* fix: resolve issue handling protobuf responses in rest streaming * raise ValueError if response_message_cls is not a subclass of proto.Message or google.protobuf.message.Message * remove response_type from pytest.mark.parametrize * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add test for ValueError in response_iterator._grab() --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
|
/cherry-pick v1 |
gcp-cherry-pick-bot bot
pushed a commit
that referenced
this pull request
Feb 13, 2024
* fix: resolve issue handling protobuf responses in rest streaming * raise ValueError if response_message_cls is not a subclass of proto.Message or google.protobuf.message.Message * remove response_type from pytest.mark.parametrize * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add test for ValueError in response_iterator._grab() --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Towards b/311671723